/**
 * @file box_audio_codec.h
 * @brief 盒式音频编解码器头文件
 * @author zzh
 * @date 2024-04-20
 */

#ifndef _BOX_AUDIO_CODEC_H
#define _BOX_AUDIO_CODEC_H

#include "audio_codec.h"

#include <esp_codec_dev.h>
#include <esp_codec_dev_defaults.h>

/**
 * @brief 盒式音频编解码器类
 * 
 * 实现了基于ES8311(输出)和ES7210(输入)的音频编解码器，
 * 支持双工通信，可配置输入参考以实现回声消除。
 */
class BoxAudioCodec : public AudioCodec {
private:
    /** @brief I2S数据接口 */
    const audio_codec_data_if_t* data_if_ = nullptr;
    /** @brief 输出控制接口 */
    const audio_codec_ctrl_if_t* out_ctrl_if_ = nullptr;
    /** @brief 输出编解码器接口 */
    const audio_codec_if_t* out_codec_if_ = nullptr;
    /** @brief 输入控制接口 */
    const audio_codec_ctrl_if_t* in_ctrl_if_ = nullptr;
    /** @brief 输入编解码器接口 */
    const audio_codec_if_t* in_codec_if_ = nullptr;
    /** @brief GPIO接口 */
    const audio_codec_gpio_if_t* gpio_if_ = nullptr;

    /** @brief 输出设备句柄 */
    esp_codec_dev_handle_t output_dev_ = nullptr;
    /** @brief 输入设备句柄 */
    esp_codec_dev_handle_t input_dev_ = nullptr;

    /**
     * @brief 创建双工通道
     * @param mclk 主时钟引脚
     * @param bclk 位时钟引脚
     * @param ws 字选择引脚
     * @param dout 数据输出引脚
     * @param din 数据输入引脚
     */
    void CreateDuplexChannels(gpio_num_t mclk, gpio_num_t bclk, gpio_num_t ws, gpio_num_t dout, gpio_num_t din);

    /**
     * @brief 从音频设备读取数据
     * @param dest 目标缓冲区
     * @param samples 要读取的样本数
     * @return 实际读取的样本数
     */
    virtual int Read(int16_t* dest, int samples) override;
    
    /**
     * @brief 向音频设备写入数据
     * @param data 源数据
     * @param samples 要写入的样本数
     * @return 实际写入的样本数
     */
    virtual int Write(const int16_t* data, int samples) override;

public:
    /**
     * @brief 构造函数
     * @param i2c_master_handle I2C主设备句柄
     * @param input_sample_rate 输入采样率
     * @param output_sample_rate 输出采样率
     * @param mclk 主时钟引脚
     * @param bclk 位时钟引脚
     * @param ws 字选择引脚
     * @param dout 数据输出引脚
     * @param din 数据输入引脚
     * @param pa_pin 功率放大器引脚
     * @param es8311_addr ES8311设备地址
     * @param es7210_addr ES7210设备地址
     * @param input_reference 是否使用参考输入
     */
    BoxAudioCodec(void* i2c_master_handle, int input_sample_rate, int output_sample_rate,
        gpio_num_t mclk, gpio_num_t bclk, gpio_num_t ws, gpio_num_t dout, gpio_num_t din,
        gpio_num_t pa_pin, uint8_t es8311_addr, uint8_t es7210_addr, bool input_reference);
    
    /**
     * @brief 析构函数
     */
    virtual ~BoxAudioCodec();

    /**
     * @brief 设置输出音量
     * @param volume 音量值
     */
    virtual void SetOutputVolume(int volume) override;
    
    /**
     * @brief 启用或禁用音频输入
     * @param enable 是否启用输入
     */
    virtual void EnableInput(bool enable) override;
    
    /**
     * @brief 启用或禁用音频输出
     * @param enable 是否启用输出
     */
    virtual void EnableOutput(bool enable) override;
};

#endif // _BOX_AUDIO_CODEC_H
